Query Agreement Cost Centre
The QueryAgreementCostCentres web service
XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to retrieve a list of Cost Centres associated with an Agreement In the Cloud Monetisation Platform, the entity that holds the instructions for generating the bills for one or more subscriptions. including the addresses and how often the bill is generated. up to a configurable limit, irrespective of the total number of Cost Centres attributed to an Agreement. The query limit protects the server against excessively large numbers of cost centres being retrieved.
QueryAgreementCostCentre Request
The QueryAgreementCostCentre request instructs the Agreement Service to query an Agreement for Cost Centres. This request contains the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
The client may use this identifier to correlate the request and the response. |
Optional |
|
AgreementNumber |
Integer8 |
The unique system generated reference number for the Agreement. |
Mandatory |
|
Datasets |
Container |
It is only possible to query using the BASIC dataset. |
Mandatory |
QueryAgreementCostCentre Response
The QueryAgreementCostCentre response has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
ExternalReference |
String69 |
Returned unmodified in the response. The client may use this identifier to correlate the request and the response. |
Optional |
|
QueryLimitExceeded |
Boolean |
Set to True if the maximum number of records that may be returned, as defined in the configuration, was exceeded. |
Mandatory |
|
AgreementCostCentres |
Container |
Zero or more repetitions of the CostCentre Container. |
Optional |
The response is returned sorted by ascending Cost Centre Code.
CostCentre Container
The CostCentre response container has the following elements:
|
Element Name |
Content Type |
Description |
Required? |
|---|---|---|---|
|
CostCentreCode |
String20 |
The customer provided Cost Centre identifier. |
Mandatory |
|
CostCentreDescription |
String30 |
The customer provided description of the Cost Centre identifier. |
Mandatory |
|
LastAmendedDate |
dateTime |
The date and time at which the Cost Centre was last amended. YYYY-MM-DDThh:mm:ssZ |
Optional |